Hub Sante AMQP API 0.5

L'API Hub Sante AMQP permet le partage d'informations entre acteurs du monde de la santé.

Servers

  • localhost:5671amqps 0.9.1local

    Instance locale du Hub Sante portée par docker-compose dans le repo du Hub

    Security:
    • X509:

      Un certificat issu d'une AC validée par le Hub est nécessaire pour l'authentification TLS

Operations

  • SUB {clientId}.in.message

    File spécifique à chaque client pour la réception de messages

    Message fonctionnel

    Operation IDreceiveMessage
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts one of the following messages:

    • #0Message basiquebasicMessage

      Message basique transportable par le Hub

      object allOf
      uid: basicMessage

      Examples

    • #1Message CISUcisuMessage

      Message CISU transportable par le Hub dans le cadre des échanges inter-forces.

      object allOf
      uid: cisuMessage

      Examples

  • PUB {clientId}.out.message

    File spécifique à chaque client pour l'envoi de messages

    Message fonctionnel

    Operation IDpublishMessage
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts one of the following messages:

    • #0Message basiquebasicMessage

      Message basique transportable par le Hub

      object allOf
      uid: basicMessage

      Examples

    • #1Message CISUcisuMessage

      Message CISU transportable par le Hub dans le cadre des échanges inter-forces.

      object allOf
      uid: cisuMessage

      Examples

  • SUB {clientId}.in.ack

    File spécifique à chaque client pour la réception des acquittements fonctionnels

    Acquittement fonctionnel

    Operation IDreceiveAck
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Acquittement fonctionnelack
    object allOf
    uid: basicMessage

    Examples

  • PUB {clientId}.out.ack

    File spécifique à chaque client pour l'envoi des acquittements fonctionnels

    Acquittement fonctionnel

    Operation IDpublishAck
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Acquittement fonctionnelack
    object allOf
    uid: basicMessage

    Examples

  • SUB {clientId}.in.info

    File spécifique à chaque client pour la réception des informations complémentaires liées au fonctionnement et aux échanges portés par le Hub Santé

    Informations complémentaires

    Operation IDreceiveInfo
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Information complémentaireinfo
    object allOf
    uid: basicMessage

    Examples

  • PUB {clientId}.out.info

    File spécifique à chaque client pour l'envoi des informations complémentaires liées au fonctionnement et aux échanges portés par le Hub Santé

    Informations complémentaires

    Operation IDpublishInfo
    clientId
    required
    string
    uid: clientId

    L'identifiant du client

    Accepts the following message:

    Information complémentaireinfo
    object allOf
    uid: basicMessage

    Examples

Messages

  • #1Enveloppe qui doit être implémentée par tous les messages échangées sur le HubmessageEnvelope

    Enveloppe des messages transportables par le Hub

    object
    uid: messageEnvelope
  • #2Message basiquebasicMessage

    Message basique transportable par le Hub

    object allOf
    uid: basicMessage
  • #3Message CISUcisuMessage

    Message CISU transportable par le Hub dans le cadre des échanges inter-forces.

    object allOf
    uid: cisuMessage
  • #4Acquittement fonctionnelack
    object allOf
    uid: basicMessage
  • #5Information complémentaireinfo
    object allOf
    uid: basicMessage

Schemas

  • object
    uid: messageEnvelope
  • object allOf
    uid: basicMessage
  • object allOf
    uid: cisuMessage
  • object
    uid: Parking
  • object
    uid: Bicyle
  • object
    uid: CallTaker
  • object
    uid: Bank
  • object
    uid: Bar
  • object
    uid: Stadium
  • object
    uid: Prison
  • object
    uid: Victims
  • object
    uid: ShoppingArea
  • object
    uid: Classroom
  • object
    uid: Warehouse
  • object
    uid: Airport
  • object
    uid: AddresseeType
  • object
    uid: CoordType
  • object
    uid: Aircraft
  • object
    uid: Arena
  • object
    uid: Automobile
  • object
    uid: Bus
  • object
    uid: BusStation
  • object
    uid: Cafe
  • object
    uid: Club
  • object
    uid: Construction
  • object
    uid: ConventionCenter
  • object
    uid: Government
  • object
    uid: Hospital
  • object
    uid: Hotel
  • object
    uid: Industrial
  • object
    uid: Library
  • object
    uid: Motorcycle
  • object
    uid: Office
  • object
    uid: Outdoors
  • object
    uid: PlaceOfWorship
  • object
    uid: Public
  • object
    uid: PublicTransport
  • object
    uid: Residence
  • object
    uid: Restaurant
  • object
    uid: School
  • object
    uid: Store
  • object
    uid: Street
  • object
    uid: Theater
  • object
    uid: Train
  • object
    uid: TrainStation
  • object
    uid: Truck
  • object
    uid: Underway
  • object
    uid: Unknown
  • object
    uid: Water
  • object
    uid: Watercraft
  • object
    uid: LocationType2
  • object
    uid: CivicAddressType
  • object
    uid: LocationType
  • object
    uid: Call
  • object
    uid: Caller
  • object
    uid: OptionalAttributeType
  • object
    uid: OtherAlertCode
  • object
    uid: ResourceType
  • object
    uid: OtherAlert
  • object
    uid: UpdateEvent
  • object
    uid: Recipients
  • object
    uid: Alert
  • object
    uid: AckEvent
  • object
    uid: AttributeType
  • object
    uid: AlertCode
  • object
    uid: PrimaryAlert
  • object
    uid: CancelEvent
  • object
    uid: AckMessageId
  • object
    uid: CreateEvent
  • object oneOf
    uid: Message
  • count
    string
    uid: count
      Allowed values:
    • "0"
    • "1"
    • "SEVERAL"
    • "MANY"
    • "UNKNOWN"
  • mainVictim
    string
    uid: mainVictim
      Allowed values:
    • "INFANT"
    • "CHILD"
    • "ADULT"
    • "PREGNANT"
    • "SENIOR"
  • type
    string
    uid: type
      Allowed values:
    • "POINT"
    • "CIRCLE"
    • "LINE"
    • "SURFACE"
    • "GRID"
    • "POLYGON"
    • "ELLIPSE"
  • heightRole
    string
    uid: heightRole
      Allowed values:
    • "MIN"
    • "MAX"
    • "AVE"
  • reporting
    string
    uid: reporting
      Allowed values:
    • "STANDARD"
    • "ATTENTION"
  • severity
    string
    uid: severity
      Allowed values:
    • "EXTREME"
    • "SEVERE"
    • "MODERATE"
    • "MINOR"
    • "UNKNOWN"
  • cancelReason
    string
    uid: cancelReason
      Allowed values:
    • "ERROR"
    • "MALEVOLENCE"
    • "OTHER"
  • msgType
    string
    uid: msgType
      Allowed values:
    • "ALERT"
    • "ACK"
    • "UPDATE"
    • "CANCEL"
  • status
    string
    uid: status
      Allowed values:
    • "ACTUAL"
    • "EXERCISE"
    • "TEST"
    • "DRAFT"
    • "SYSTEM"
  • object
    uid: nestedObj

    nested object - depth 1

  • object
    uid: nestedNested

    nested object - depth 2